Ektron CMS400.Net Reference

>>Managing User Communities > Community Groups > Community Group Server Controls > CommunityGroupMembers Server Control

CommunityGroupMembers Server Control

The CommunityGroupMembers server control allows you display a list of members

in a community group

pending approval to join the group

invited to join the group

In addition, if a logged-in user is the community group’s administrator, assigned the Community Group Administrator role, or a site administrator, he can approve pending members, remove members, and cancel invitations.

The following links appear on the CommunityGroupMembers Server Control when a community group’s administrator or Ektron CMS400.NET administrator is logged in and viewing the control.

Link

Description

Members

A list of current members.

Pending Members

Members who have asked to join the community group, but have yet to be accepted. This link is used when access to the community group is restricted. See Also: Accepting/Declining Requests to Join a Community Group

Invitations

Members who have been invited to join the group but have not yet accepted the invitation. This link is used when access to the community group is restricted.

Remove

Removes member from community group.

CommunityGroupMembers Server Control Properties

The CommunityGroupMembers server control properties are described in this table.

Note: The following table only lists Ektron-specific properties. It does not describe native .NET properties such as font, height, width and border style. For documentation of these properties, see Visual Studio help.

Property

Description

Data Type

Authenticated

Indicates if you are logged in to the CMS Explorer and can use it to browse to Content, Collections, etc. See Also: Using CMS Explorer to Browse Your Ektron CMS400.NET Site

String

AvatarHeight

The display height (in pixels) of the avatar in the results box.

Integer

AvatarWidth

The display width (in pixels) of the avatar in the results box.

Integer

CacheInterval

Sets the amount of time the server control’s data is cached. The default is 0 (zero).

For example, if you want to cache the data for five minutes, set this property to 300 (three hundred). See Also: Caching with Server Controls

Double

DefaultCommunityGroupID

The default community group ID for this control to use if no matching dynamic parameter value is passed.

Long

DisplayMode

Select whether this control displays a community group’s current members or their pending members. Choices are:

Members - current group members

PendingMembers - users who asked or were invited to join the group

eDisplayMode

DisplayXslt

Determines how information is displayed on the page. Enter the path to the XSL file. It can be relative or absolute.

Warning! If you specify an external file, it is strongly recommended that you do not store this file in your site's Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

Warning! If you enter a valid EkML file at the MarkupLanguage property, the DisplayXslt property value is ignored.

String

 

DoInitFill

By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, FIll is automatically called during the Page Render event.

You might do this if you need to set or change a property on the control in codebehind and have it render with your changes shown.

Boolean

DynamicParameter

Gets or sets the QueryString parameter to read a community group ID dynamically. To use the default community group ID, leave blank.

String

Hide

Used to hide output of the control in design time and run time.

True = Hide control

False = Display control

Boolean

Language

Set a language for viewing the CommunityGroupMembers control. This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

Integer

Link

Add a link to the member profile page’s Web form. This allows a user to click a link in the community group members list and be taken to a member’s profile page. There are two variables used within the link that represent the user’s ID and the user’s name.

{0} - represents the user’s ID.

{1} - represents the user’s name.

You need to have both variables in the link. The Web form can be relative or absolute. Below is an example.

userprofilepage.aspx?gid={0}&gn={1}

String

LinkTarget

Determines the type of window that appears for this Web form when a user clicks an item in the CommunityGroupMembers control. The default is _self.

_Self - opens in same window

_Top - opens in parent window

_Blank - opens in new window

_Parent - opens in the parent frame

ItemLinktargets

MarkupLanguage

Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the *.ekml file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See Also: Controlling Output with Ektron Markup Language

String

MaxResults

The Maximum number of items to fetch. 0 (zero) = unlimited.

Integer

Stylesheet

Specify the path to a style sheet for use with the server control. The location can be relative or absolute. Leave blank to use the default style sheet.

Warning! If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

String

SuppressWrapperTags

Suppresses the output of the span/div tags around the control. The default is False.

True - Suppress wrap tags.

False - Allow wrap tags.

Boolean

WrapTag

Allows a developer to specify a server control’s tag.

The default is Span.

Span - The <span> tag is used to designate an inline portion of an HTML document as a span element.

Div - The <div> tag is used when you want to apply attributes to a block of code.

Custom - Allows you to use a custom tag.

String


Visit the Ektron Dev Center at http://dev.ektron.com 1-866 - 4 - EKTRON

Ektron CMS400.NET Reference Version 8.02 SP1 Rev 1

Ektron Documentation,© 2011 Ektron, Inc.